4glte3na 2.2.2
Loading...
Searching...
No Matches
c4glte3na.h File Reference

This file contains API for 4G LTE 3 NA Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  c4glte3na_t
 4G LTE 3 NA Click context object. More...
struct  c4glte3na_cfg_t
 4G LTE 3 NA Click configuration object. More...

Macros

#define C4GLTE3NA_CMD_AT   "AT"
 4G LTE 3 NA control commands.
#define C4GLTE3NA_CMD_GET_MODEL_ID   "AT+CGMM"
#define C4GLTE3NA_CMD_GET_SW_VERSION   "AT+CGMR"
#define C4GLTE3NA_CMD_GET_SERIAL_NUM   "AT+CGSN"
#define C4GLTE3NA_CMD_FACTORY_RESET   "AT&F"
#define C4GLTE3NA_CMD_SET_MODULE_FUNCTIONALITY   "AT+CFUN"
#define C4GLTE3NA_CMD_EPS_NETWORK_REGISTRATION   "AT+CEREG"
#define C4GLTE3NA_CMD_SIGNAL_QUALITY_REPORT   "AT+CSQ"
#define C4GLTE3NA_CMD_OPERATOR_SELECTION   "AT+COPS"
#define C4GLTE3NA_CMD_SEND_SMS   "AT+CMGS"
#define C4GLTE3NA_CMD_SELECT_SMS_FORMAT   "AT+CMGF"
#define C4GLTE3NA_CMD_DEFINE_PDP_CONTEXT   "AT+CGDCONT"
#define C4GLTE3NA_CMD_SHOW_PDP_ADDRESS   "AT+CGPADDR"
#define C4GLTE3NA_CMD_ACTIVATE_PDP_CONTEXT   "AT+CGACT"
#define C4GLTE3NA_CMD_CREATE_SOCKET   "AT+USOCR"
#define C4GLTE3NA_CMD_CLOSE_SOCKET   "AT+USOCL"
#define C4GLTE3NA_CMD_CONNECT_SOCKET   "AT+USOCO"
#define C4GLTE3NA_CMD_WRITE_SOCKET_DATA   "AT+USOWR"
#define C4GLTE3NA_CMD_READ_SOCKET_DATA   "AT+USORD"
#define C4GLTE3NA_CMD_GPIO_CONFIG   "AT+UGPIOC"
#define C4GLTE3NA_RSP_OK   "OK"
 4G LTE 3 NA device response for AT commands.
#define C4GLTE3NA_RSP_ERROR   "ERROR"
#define C4GLTE3NA_URC_CREATE_SOCKET   "+USOCR: "
 4G LTE 3 NA device unsolicited response code (URC) settings.
#define C4GLTE3NA_URC_RECEIVED_DATA   "+UUSORD: "
#define C4GLTE3NA_POWER_STATE_OFF   0
 4G LTE 3 NA power state settings.
#define C4GLTE3NA_POWER_STATE_ON   1
#define C4GLTE3NA_POWER_STATE_RESET   2
#define C4GLTE3NA_TX_DRV_BUFFER_SIZE   256
 4G LTE 3 NA driver buffer size.
#define C4GLTE3NA_RX_DRV_BUFFER_SIZE   256
#define C4GLTE3NA_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  c4glte3na_return_value_t {
  C4GLTE3NA_OK = 0 , C4GLTE3NA_ERROR = -1 , C4GLTE3NA_ERROR_TIMEOUT = -2 , C4GLTE3NA_ERROR_CMD = -3 ,
  C4GLTE3NA_ERROR_UNKNOWN = -4
}
 4G LTE 3 NA Click return value data. More...

Functions

void c4glte3na_cfg_setup (c4glte3na_cfg_t *cfg)
 4G LTE 3 NA configuration object setup function.
err_t c4glte3na_init (c4glte3na_t *ctx, c4glte3na_cfg_t *cfg)
 4G LTE 3 NA initialization function.
err_t c4glte3na_generic_write (c4glte3na_t *ctx, uint8_t *data_in, uint16_t len)
 4G LTE 3 NA data writing function.
err_t c4glte3na_generic_read (c4glte3na_t *ctx, uint8_t *data_out, uint16_t len)
 4G LTE 3 NA data reading function.
void c4glte3na_set_pwr_pin (c4glte3na_t *ctx, uint8_t state)
 4G LTE 3 NA set PWR pin function.
void c4glte3na_set_rst_pin (c4glte3na_t *ctx, uint8_t state)
 4G LTE 3 NA set RST pin function.
void c4glte3na_set_rts_pin (c4glte3na_t *ctx, uint8_t state)
 4G LTE 3 NA set RTS pin function.
uint8_t c4glte3na_get_ring_pin (c4glte3na_t *ctx)
 4G LTE 3 NA get RING pin function.
uint8_t c4glte3na_get_cts_pin (c4glte3na_t *ctx)
 4G LTE 3 NA get CTS pin function.
void c4glte3na_set_power_state (c4glte3na_t *ctx, uint8_t state)
 4G LTE 3 NA set power state function.
void c4glte3na_cmd_run (c4glte3na_t *ctx, uint8_t *cmd)
 4G LTE 3 NA cmd run function.
void c4glte3na_cmd_set (c4glte3na_t *ctx, uint8_t *cmd, uint8_t *value)
 4G LTE 3 NA cmd set function.
void c4glte3na_cmd_get (c4glte3na_t *ctx, uint8_t *cmd)
 4G LTE 3 NA cmd get function.
void c4glte3na_cmd_help (c4glte3na_t *ctx, uint8_t *cmd)
 4G LTE 3 NA cmd help function.
void c4glte3na_set_sim_apn (c4glte3na_t *ctx, uint8_t *sim_apn)
 Set sim card APN.
void c4glte3na_send_sms_text (c4glte3na_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 4G LTE 3 NA send SMS in text mode.
err_t c4glte3na_send_sms_pdu (c4glte3na_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 4G LTE 3 NA send SMS in PDU mode.

Detailed Description

This file contains API for 4G LTE 3 NA Click Driver.

Enumeration Type Documentation

◆ c4glte3na_return_value_t

4G LTE 3 NA Click return value data.

Predefined enum values for driver return values.

Enumerator
C4GLTE3NA_OK 
C4GLTE3NA_ERROR 
C4GLTE3NA_ERROR_TIMEOUT 
C4GLTE3NA_ERROR_CMD 
C4GLTE3NA_ERROR_UNKNOWN